AsyncGenerator

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2020.

Das AsyncGenerator-Objekt wird von einer Async Generator Function zurückgegeben und entspricht sowohl dem asynchronen iterierbaren Protokoll als auch dem asynchronen Iterator-Protokoll.

Methoden von Async-Generatoren geben immer Promise-Objekte zurück.

AsyncGenerator ist eine Unterklasse der versteckten Klasse AsyncIterator.

Konstruktor

Es gibt keine JavaScript-Entität, die dem AsyncGenerator-Konstruktor entspricht. Instanzen von AsyncGenerator müssen von Async Generator Functions zurückgegeben werden:

js
async function* createAsyncGenerator() {
  yield Promise.resolve(1);
  yield await Promise.resolve(2);
  yield 3;
}
const asyncGen = createAsyncGenerator();
asyncGen.next().then((res) => console.log(res.value)); // 1
asyncGen.next().then((res) => console.log(res.value)); // 2
asyncGen.next().then((res) => console.log(res.value)); // 3

Es gibt nur ein verstecktes Objekt, das das Prototyp-Objekt ist, das von allen Objekten geteilt wird, die durch Async Generator Functions erstellt wurden. Dieses Objekt wird oft als AsyncGenerator.prototype stilisiert, um es wie eine Klasse aussehen zu lassen, aber es sollte passenderweise AsyncGeneratorFunction.prototype.prototype genannt werden, da AsyncGeneratorFunction eine tatsächliche JavaScript-Entität ist. Um die Prototypkette von AsyncGenerator-Instanzen zu verstehen, siehe AsyncGeneratorFunction.prototype.prototype.

Instanz-Eigenschaften

Diese Eigenschaften sind auf AsyncGenerator.prototype definiert und werden von allen AsyncGenerator-Instanzen geteilt.

AsyncGenerator.prototype.constructor

Die Konstruktorfunktion, die das Instanzobjekt erstellt hat. Für AsyncGenerator-Instanzen ist der Anfangswert AsyncGeneratorFunction.prototype.

Hinweis: AsyncGenerator-Objekte speichern keinen Verweis auf die Async-Generatorfunktion, die sie erstellt hat.

AsyncGenerator.prototype[Symbol.toStringTag]

Der Anfangswert der [Symbol.toStringTag]-Eigenschaft ist der String "AsyncGenerator". Diese Eigenschaft wird in Object.prototype.toString() verwendet.

Instanz-Methoden

Erbt auch Instanzmethoden von seinem übergeordneten AsyncIterator.

AsyncGenerator.prototype.next()

Gibt ein Promise zurück, das mit dem gegebenen Wert aufgelöst wird, der durch den yield-Ausdruck bereitgestellt wurde.

AsyncGenerator.prototype.return()

Wirkt so, als ob eine return-Anweisung an der aktuellen angehaltenen Position im Körper des Generators eingefügt wird, was den Generator beendet und dem Generator ermöglicht, alle Aufräumarbeiten bei Kombination mit einem try...finally-Block durchzuführen.

AsyncGenerator.prototype.throw()

Wirkt so, als ob eine throw-Anweisung an der aktuellen angehaltenen Position im Körper des Generators eingefügt wird, was den Generator über einen Fehlerzustand informiert und ihm ermöglicht, den Fehler zu behandeln oder Aufräumarbeiten durchzuführen und sich selbst zu schließen.

Beispiele

Async Generator Iteration

Das folgende Beispiel iteriert über einen Async-Generator und protokolliert die Werte 1–6 in der Konsole in abnehmenden Zeitintervallen. Beachten Sie, wie jedes Mal ein Promise zurückgegeben wird, das jedoch automatisch innerhalb der for await...of-Schleife aufgelöst wird.

js
// An async task. Pretend it's doing something more useful
// in practice.
function delayedValue(time, value) {
  return new Promise((resolve /*, reject */) => {
    setTimeout(() => resolve(value), time);
  });
}

async function* generate() {
  yield delayedValue(2000, 1);
  yield delayedValue(1000, 2);
  yield delayedValue(500, 3);
  yield delayedValue(250, 4);
  yield delayedValue(125, 5);
  yield delayedValue(50, 6);
  console.log("All done!");
}

async function main() {
  for await (const value of generate()) {
    console.log("value", value);
  }
}

main().catch((e) => console.error(e));

Spezifikationen

Specification
ECMAScript® 2026 Language Specification
# sec-asyncgenerator-objects

Browser-Kompatibilität

Siehe auch